Add Modelica Tough coupling user guide #3696
Conversation
|
@EttoreZ Would you please take another look at the changes? |
|
Hey @JayHuLBL just two quick comments:
|
|
@EttoreZ Thanks for the comments. I just addressed it. Please double-check. |
|
@JayHuLBL the changes look good to me. |
|
@mwetter It's ready for your review. |
There was a problem hiding this comment.
We must not assume that an installation has write access to the directory where the Buildings library is installed.
Moreover, doStep uses:
modelicaWorkingPath = os.getcwd()
py_dir = os.path.join(modelicaWorkingPath,'Resources/Python-Sources')so we cannot assume the temporary directory is this one.
| def doStep(dblInp, state): | ||
|
|
||
| modelicaWorkingPath = os.getcwd() | ||
| py_dir = os.path.join(modelicaWorkingPath,'Resources/Python-Sources') |
There was a problem hiding this comment.
This won't work if the working directory is not Buildings.
| # conditions for TOUGH simulation. | ||
| # This temporary folder should be created in advance before calling this | ||
| # python script. | ||
| tou_tmp = os.path.join(py_dir, 'toughTemp') |
There was a problem hiding this comment.
Python has a way to determine the name of a temporary directory. Why don't we use it?
| tou_tmp = os.path.join(py_dir, 'toughTemp') | ||
|
|
||
| # Heat flux from borehole wall to ground: Modelica --> Tough | ||
| Q = dblInp[:10] |
There was a problem hiding this comment.
What is the 10, and how does it relate to the Modelica sizes?
There was a problem hiding this comment.
The variable names in this figure must be the same as the Modelica variable names.
Also, Modelica is never written as MODELICA in any documentation (and in fact, it is written as Modelica in the borehole figure.
Go through the documentation as check for consistency.
There was a problem hiding this comment.
Why is the name TOUGHResponse and not just TOUGH?
We also don't use EnergyPlus_9_6_0Response or Python_xxx_Response.
| <p> | ||
| This package contains models demonstrating the coupling between Modelica simulation | ||
| and <a href=\"https://tough.lbl.gov/software/tough3\">TOUGH</a> simulation. | ||
| Note that to run the coupled simulation, the TOUGH simulator should be installed. |
There was a problem hiding this comment.
"should" it be installed, or "must" it be installed? "Should" is not sufficient.
There was a problem hiding this comment.
This user guide lacks structure. It needs to be restructured to give a logical flow.
There was a problem hiding this comment.
Opening this file in OMEdit gives an error message due to a wrong annotation.
No description provided.